List Restores

This API returns a list of restore processes, including their status, progress, and the scopes that were restored.

Endpoint Details

URL	/v1/restore/list
Method	GET
Authorization	Bearer Token

---

Request Headers

Header	Type	Description
Content-Type	String	Must be application/json

---

Response

Here is an example of a response when viewing a list of data:

Response

{
    "data": [
        {
            "id": "e0f92810-1f2b-4c58-8088-690296e1c504",
            "backup_id": "f5316dfe-52a1-4289-8d13-9fdc81d3e11b",
            "status": 3,
            "progress_percentage": 100,
            "current_step": "Completed",
            "scopes_to_restore": [
                1,
                2
            ],
            "started_at": 1784709299,
            "created_by": "0a937c60-0ed4-4d06-870a-2e284b54287d",
            "created_by_name": "Admin Aplikasi"
        },
        {
            "id": "a5c96a9d-abea-4271-b77b-acb135c1c84a",
            "backup_id": "81c112d7-482f-4041-9171-875e7bd05516",
            "status": 4,
            "current_step": "Failed",
            "scopes_to_restore": [
                1,
                2,
                3,
                4
            ],
            "error_message": "wipe masking failed: rpc error: code = Unavailable desc = connection error: desc = \"transport: Error while dialing: dial tcp 10.43.231.151:3000: connect: connection refused\"",
            "started_at": 1781236183,
            "created_by": "0a11c692-b992-4d02-8a55-22b005459c50",
            "created_by_name": "adit purwa"
        },
        {
            "id": "298fe918-456f-4bfa-a9ec-85eef339d01b",
            "backup_id": "d5439731-b65f-4612-80ea-c39a0cfef6db",
            "status": 3,
            "progress_percentage": 100,
            "current_step": "Completed",
            "scopes_to_restore": [
                1,
                2,
                3,
                4
            ],
            "started_at": 1781177445,
            "created_by": "414a45e9-f194-4a8a-9876-97abb990d4d9",
            "created_by_name": "Iqbal Adhi"
        }
    ],
    "pagination": {
        "total": 3,
        "page": 1,
        "page_size": 20,
        "last_page": 1
    }
}

---

Field Descriptions

Field	Type	Description
id	UUID	Unique identifier of the restore process
backup_id	UUID	Identifier of the backup that was restored
status	Integer	Current status code of the restore process
progress_percentage	Integer	Progress of the restore, expressed as a percentage
current_step	String	Description of the current step of the restore process
scopes_to_restore	Array	List of scope codes restored from the backup
error_message	String	Error message describing why the restore failed
started_at	Integer	Timestamp when the restore started, in Unix format
created_by	UUID	Identifier of the user who started the restore
created_by_name	String	Display name of the user who started the restore
total	Integer	Total number of restore processes available
page	Integer	Current page number
page_size	Integer	Number of records returned per page
last_page	Integer	Total number of available pages

---

info

• A valid Bearer Token is required to access this endpoint.
• The scopes_to_restore array uses the following codes:
  • 1 = System Configuration
  • 2 = Keys
  • 3 = Audit Log
  • 4 = System Log
• The progress_percentage field may not be present for restores that did not complete successfully.
• The error_message field is only present when the restore failed.
• Unix timestamp fields can be converted to a human-readable date and time format as needed.